Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update basic-writing-and-formatting-syntax.md #34693

Closed
wants to merge 3 commits into from
Closed

Update basic-writing-and-formatting-syntax.md #34693

wants to merge 3 commits into from

Conversation

syed-ateeb-naveed
Copy link

@syed-ateeb-naveed syed-ateeb-naveed commented Sep 23, 2024 •
edited
Loading

In the heading "Specifying the theme an image is shown to", added a Note to clarify the purpose of the tag and added the code itself to display the picture for illustration.

Why:

I was just reading the docs to improve my README, where I came across this code and noticed there was no picture attached for illustration. Furthermore, I also noticed an <img> tag, but its purpose was not given, so I decided to clarify it with NOTE.

Closes:
GitHub Docs Issue #34694

What's being changed (if available, include any code snippets, screenshots, or gifs):

Before:

image

After:

image
Shows a picture of moon and stars, as I have dark mode selected

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.

  • For content changes, I have completed the self-review checklist.

@syed-ateeb-naveed
Update basic-writing-and-formatting-syntax.md
41cf302 
In the heading "Specifying the theme an image is shown to", added a Note to clarify the purpose of the <img> tag and added the code itself to display the picture for illustration.
@welcome Welcome
Copy link

welcome bot commented Sep 23, 2024

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Sep 23, 2024
@syed-ateeb-naveed syed-ateeb-naveed marked this pull request as draft September 23, 2024 07:33
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 23, 2024 •
edited
Loading

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.

Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

@syed-ateeb-naveed syed-ateeb-naveed marked this pull request as ready for review September 23, 2024 07:57
@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team get started Content related to "Getting Started" doc set and removed triage Do not begin working on this issue until triaged by the team labels Sep 23, 2024
@nguyenalex836
Copy link
Contributor

@syed-ateeb-naveed Thanks so much for opening a PR! I'll get this triaged for review ✨

@nguyenalex836 nguyenalex836 linked an issue Sep 23, 2024 that may be closed by this pull request
Enhance Documentation on Theme-Specific Image Display with Illustration and <img> Tag Clarification #34694
Closed
1 task
@nguyenalex836 nguyenalex836 added the waiting for review Issue/PR is waiting for a writer's review label Sep 23, 2024
@subatoi subatoi added the needs SME This proposal needs review from a subject matter expert label Sep 24, 2024
@github-actions GitHub Actions
Copy link
Contributor

Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert 👀

@nguyenalex836
Copy link
Contributor

@syed-ateeb-naveed Thank you for your patience while our SME team reviewed! You are absolutely correct regarding the lack of illustration and the need to more clearly define the purpose of the <img> tag ✨

While we feel your updates to more clearly define the purpose of the <img> tag may be slightly too general, rest assured we will be reviewing internally how best to address the article as a whole as thoughtfully as possible 💛

Thank you so much for raising a flag on these issues, and your willingness to contribute to our docs! 🙇

@nguyenalex836 nguyenalex836 added SME reviewed An SME has reviewed this issue/PR and removed waiting for review Issue/PR is waiting for a writer's review needs SME This proposal needs review from a subject matter expert labels Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
content This issue or pull request belongs to the Docs Content team get started Content related to "Getting Started" doc set SME reviewed An SME has reviewed this issue/PR
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Enhance Documentation on Theme-Specific Image Display with Illustration and <img> Tag Clarification
3 participants
@syed-ateeb-naveed @nguyenalex836 @subatoi